home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / dev / misc / vahunz.readme < prev    next >
Encoding:
Text File  |  1998-05-05  |  6.4 KB  |  180 lines
  1. Short:    Make source code un-/more legible
  2. Author:   Thomas Aglassinger <agi@giga.or.at>
  3. Uploader: Thomas Aglassinger <agi@giga.or.at>
  4. Version:  1.3
  5. Type:     dev/misc
  6. Requires: AmigaOS 2.04, 68020, 2MB
  7. Kurz:     Macht Quellcode un-/besser lesbar
  8.  
  9. TITLE
  10.  
  11.   vahunz - Make source code un-/more legible.
  12.  
  13. VERSION 
  14.  
  15.   1.3
  16.  
  17. AUTHOR
  18.  
  19.   Thomas Aglassinger <agi@giga.or.at>
  20.  
  21. DESCRIPTION
  22.  
  23.   Vahunz is a CLI-based replace command that can supersede many words
  24.   across several files with only one invocation.
  25.  
  26.   Normally the target words will be created randomly, turning
  27.   meaningful names into unlegible garbage. For example, a function
  28.   name like read_input_file() could be replaced by g7B() or something
  29.   as useless. Additionally, comments and indention can be removed.
  30.  
  31.   As an option, you can specify specific substitutes, so Vahunz can
  32.   also be applied in a non-destructive manner. This can be used to
  33.   replace inconsistent, too short or unlegible names by something more
  34.   meaningful. Among programmers, this process is known as "The Great
  35.   Renaming".
  36.  
  37. FEATURES
  38.  
  39.   - Stores less/more legible copy in a different directory
  40.   - Supports C, C++ and Java
  41.   - New names since last run are easy to see
  42.   - Names can easily be declared to be modified or left untouched;
  43.     for example, it makes no sense to replace printf().
  44.   - Words being part of comments or string constants are not replaced
  45.   - Fast, as internally names are stored in an AVL-tree
  46.   - Several options to back-trace problems in vahunzed code
  47.  
  48. NEW FEATURES
  49.  
  50.   - Can be kept from storing unused names into dictionaries
  51.   - Now auto-detects programming language and decides which
  52.     internal keyword dictionary to use
  53.   - Can read keywords from external dictionary
  54.   - Included source code (vahunzed ANSI C)
  55.   - Some bugfixes and minor improvements
  56.  
  57. SPECIAL REQUIREMENTS
  58.  
  59.   AmigaOS 2.04, 2MB of regular memory, 68020
  60.  
  61. AVAILABILITY
  62.  
  63.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  64.  
  65.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  66.  
  67.   - http://www.giga.or.at/~agi/vahunz/
  68.  
  69. PRICE
  70.  
  71.   Freeware.
  72.  
  73. DISTRIBUTABILITY
  74.  
  75.   Freely distributable as long the conditions described in the manual
  76.   are met.
  77.  
  78. EXAMPLE
  79.  
  80.   For example, one might have a code excerpt like this:
  81.  
  82.     int main(void)
  83.     {
  84.         while (sepp_age < 83)
  85.         {
  86.             grow_older(sepp_name, &sepp_age);
  87.             print_sepp();
  88.         }
  89.         printf("\n%s died.\n", sepp_name);
  90.         exit(EXIT_SUCCESS);
  91.     }
  92.  
  93.   After vahunzing, this is what it might look like:
  94.  
  95.     int main(void)
  96.     {
  97.     while (g8B < 83)
  98.     {
  99.     z3V(v6Z, &g8B);
  100.     f4V();
  101.     }
  102.     printf("\n%s died.\n", v6Z);
  103.     exit(EXIT_SUCCESS);
  104.     }
  105.  
  106.   As you can see, the internal names have been garbled, but the
  107.   symbols of the standard library are preserved.
  108.  
  109.  
  110. ============================= Archive contents =============================
  111.  
  112. Original  Packed Ratio    Date     Time    Name
  113. -------- ------- ----- --------- --------  -------------
  114.   143717   50263 65.0% 20-Feb-98 19:42:54 +amiga.ignore
  115.     5365    2332 56.5% 20-Feb-98 19:42:36 +ansi.ignore
  116.   132716   45805 65.4% 20-Feb-98 19:43:10 +unix.ignore
  117.      204     116 43.1% 09-Feb-98 08:37:14 +Makefile
  118.      367     236 35.6% 09-Feb-98 08:38:44 +older.c
  119.      165     118 28.4% 09-Feb-98 08:34:48 +older.h
  120.      781     413 47.1% 14-Feb-98 20:13:40 +sepp.c
  121.      309     180 41.7% 14-Apr-98 06:00:42 +c.keywords
  122.      394     225 42.8% 14-Apr-98 06:00:42 +cpp.keywords
  123.      100      77 23.0% 14-Apr-98 06:00:42 +java.keywords
  124.     5738    2585 54.9% 19-Apr-98 18:41:06 +beyond.html
  125.     6082    2504 58.8% 19-Apr-98 18:40:54 +dictionary.html
  126.     4711    1929 59.0% 19-Apr-98 18:45:36 +future.html
  127.      138     138  0.0% 14-Jan-96 17:27:46 +back.gif
  128.      190     190  0.0% 14-Jan-96 17:20:08 +copy.gif
  129.      170     170  0.0% 14-Jan-96 17:14:34 +index.gif
  130.      176     176  0.0% 14-Jan-96 17:14:44 +main.gif
  131.      189     189  0.0% 14-Jan-96 17:15:02 +next.gif
  132.      168     168  0.0% 14-Jan-96 17:28:12 +noback.gif
  133.      211     211  0.0% 14-Jan-96 17:20:36 +nocopy.gif
  134.      200     200  0.0% 14-Jan-96 17:15:28 +noindex.gif
  135.      201     201  0.0% 11-Jan-98 16:39:54 +nomain.gif
  136.      212     212  0.0% 14-Jan-96 17:15:52 +nonext.gif
  137.      213     213  0.0% 15-Jul-96 23:44:28 +noprev.gif
  138.      188     188  0.0% 14-Jan-96 17:16:08 +prev.gif
  139.      141     141  0.0% 04-Nov-95 02:20:36 +up.gif
  140.      981     981  0.0% 21-Feb-98 01:00:48 +vahunz-now.gif
  141.     1553    1553  0.0% 19-Apr-98 18:40:04 +vahunz.gif
  142.     4388    1863 57.5% 19-Apr-98 18:45:34 +index.html
  143.     5868    2547 56.5% 19-Apr-98 18:41:04 +inside.html
  144.     3895    1704 56.2% 19-Apr-98 18:41:00 +keyctionary.html
  145.     3484    1676 51.8% 19-Apr-98 18:40:34 +legal.html
  146.     5432    2398 55.8% 19-Apr-98 18:40:32 +overview.html
  147.     3477    1689 51.4% 19-Apr-98 18:40:38 +problems.html
  148.    12181    4743 61.0% 19-Apr-98 18:40:26 +reference.html
  149.     1558     761 51.1% 19-Apr-98 18:40:40 +requirements.html
  150.     2945    1383 53.0% 19-Apr-98 18:41:08 +source.html
  151.     2276    1069 53.0% 19-Apr-98 18:40:36 +support.html
  152.    10876    4336 60.1% 19-Apr-98 18:40:30 +tutorial.html
  153.     2056     964 53.1% 19-Apr-98 18:40:46 +use-case-1.html
  154.     4923    2073 57.8% 19-Apr-98 18:40:48 +use-case-2.html
  155.     2913    1349 53.6% 19-Apr-98 18:40:50 +use-case-3.html
  156.     3469    1689 51.3% 19-Apr-98 18:40:52 +use-case-4.html
  157.     3007    1400 53.4% 19-Apr-98 18:40:56 +use-case-5.html
  158.     2734    1255 54.0% 19-Apr-98 18:40:58 +use-case-6.html
  159.     1195     343 71.2% 19-Apr-98 16:08:14 +compile
  160.    25256    9275 63.2% 24-Oct-97 04:36:18 +COPYING.LIB
  161.     5677    1758 69.0% 19-Apr-98 18:47:10 +ubi_AVLtree.c
  162.     1981     858 56.6% 19-Apr-98 18:47:10 +ubi_AVLtree.h
  163.     6382    2291 64.1% 19-Apr-98 18:47:10 +ubi_BinTree.c
  164.     3152    1302 58.6% 19-Apr-98 18:47:10 +ubi_BinTree.h
  165.     6923    2058 70.2% 19-Apr-98 18:47:12 +expstr.c
  166.     2562     919 64.1% 19-Apr-98 18:47:12 +expstr.h
  167.     1105     495 55.2% 19-Apr-98 18:47:12 +udebug.h
  168.     8107    2883 64.4% 19-Apr-98 18:47:12 +umemory.c
  169.     2321     886 61.8% 19-Apr-98 18:47:12 +umemory.h
  170.     3414    1400 58.9% 19-Apr-98 18:47:12 +ustring.c
  171.     1606     712 55.6% 19-Apr-98 18:47:14 +ustring.h
  172.     1953     771 60.5% 19-Apr-98 18:47:14 +utypes.h
  173.     1517     676 55.4% 19-Apr-98 18:47:14 +keywords.c
  174.    24601    8509 65.4% 19-Apr-98 18:47:14 +vahunz.c
  175.     1046     497 52.4% 19-Apr-98 18:47:16 +vahunz_rev.h
  176.    40124   23073 42.4% 19-Apr-98 16:40:10 +vahunz
  177.     2547    1345 47.1% 19-Apr-98 18:46:54 +vahunz.readme
  178. -------- ------- ----- --------- --------
  179.   522531  204664 60.8% 20-Apr-98 22:07:30   64 files
  180.